Update README with detailed instructions #6
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Diff CoverageDiff: origin/main...HEAD, staged and unstaged changesNo lines with coverage information in this diff. |
There was a problem hiding this comment.
Pull Request Overview
This PR enriches the project’s README by providing a clearer description, detailed setup steps, and CI information.
- Expanded the introductory description and added a “Features” list
- Replaced “Usage” with “Getting Started” including step-by-step commands
- Introduced a “Common Makefile Commands” section and a CI details section
Comments suppressed due to low confidence (1)
README.md:9
- The Features section no longer lists Poetry for dependency management. Consider re-adding a bullet like "Poetry for dependency management" to reflect the project setup.
- **Poetry** for dependency management
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Testing
make lintmake typecheck(fails: Unnecessary "# type: ignore" comment)make test